Make titles in non-docs markdown files more consistent with style guide #552
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request aims to improve the consistency of headings in the README.md by applying sentence case, following the Google developer documentation style guide. The changes are a positive step. I've provided a couple of suggestions to further improve consistency, one with a direct code change for a hyphenated term, and another pointing out some remaining inconsistencies in capitalization for the term 'Agent'. Overall, these are valuable documentation improvements.
ava-cassiopeia
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Google dev docs style guide recommends sentence case for heading (source), so this PR is a small tweak that makes the headings in the README et al. more consistent.
Beyond simple consistency, this allows us to call attention to key words or phrases using capitalization.
Specifically avoids the
docs/dir for now because that'll require a bit more work.